Add Documentation for End-to-End Test Suite #203
Conversation
Signed-off-by: Priyanshi Gaur <[email protected]>
Signed-off-by: Priyanshi Gaur <[email protected]>
Signed-off-by: Priyanshi Gaur <[email protected]>
There was a problem hiding this comment.
Thanks for this excellent PR @nox1134 and for all your hard work on the Summer of Code project!
There are quite a few suggestions but they fall into these broad categories:
- Using active instead of passive when writing - I've fixed the ones that Vale has flagged
- I've made a commit to add Codeception and XPath to the allowed terms
- Using inline code syntax (double backtick) for file and folder names, and anything where we're referring to something like a command to be run.
- Not using Camel Case in headings - use sentence case (only the first letter is capitalised unless there's another grammatical reason why to capitalise others, in which case we use vale off)
- A few small changes to use more inclusive language
Hopefully should be fairly straightforward to implement but shout if you have any further issues with Vale in #t-education on Slack!
Signed-off-by: Priyanshi Gaur <[email protected]>
Signed-off-by: Priyanshi Gaur <[email protected]>
Signed-off-by: Priyanshi Gaur <[email protected]>
|
XPath wasn't added, so I have added XPath and also php to the allowed terms. |
php (lower case) should not be added. It should always be capitalised. Where was it that it was flagging this up? It might be a missed filename being surrounded by inline code syntax. I added XPath but totally missed pushing the commit - sorry! |
Yeah you are right! A filename not being surrounded by inline code syntax was causing that error. |
Signed-off-by: Priyanshi Gaur <[email protected]>
Signed-off-by: Priyanshi Gaur <[email protected]>
Signed-off-by: Priyanshi Gaur <[email protected]>
Signed-off-by: Priyanshi Gaur <[email protected]>
Signed-off-by: Priyanshi Gaur <[email protected]>
|
This pull request has been mentioned on Mautic Forums. There might be relevant details there: https://forum.mautic.org/t/gsoc-2024-project-report-end-to-end-test-suite-for-mautic/33354/1 |
This PR introduces documentation for the end-to-end test suite being developed as part of the GSoC project.
The documentation covers the following aspects: